en | Getting started

Please open Firefox and then install the KeeFox addon from https://addons.mozilla.org/en-US/firefox/addon/keefox/

Then follow the step by step instructions to setup KeeFox and learn how to use it.

The introductory tutorial for new users can be found at http://tutorial.keefox.org/part1

Advanced users may want to learn how to add KeeFox to their existing portable apps solution: Portable KeeFox

Downloading

The current stable version of KeeFox can be downloaded from https://addons.mozilla.org/en-US/firefox/addon/keefox/

Beta versions are available at https://addons.mozilla.org/en-US/firefox/addon/keefox/versions

Development snapshots (pre-beta) are sometimes available from https://github.com/luckyrat/KeeFox/releases

Please note that the development snapshot / experimental version has only been tested on a single development machine and may not install and/or run as expected. Do not use it in a production environment.

Since Firefox 41, it is no longer possible to install development snapshots unless you use the Developer Edition and disable extension signing checks as explained in https://wiki.mozilla.org/Addons/Extension_Signing. Installing the beta version via https://addons.mozilla.org/en-US/firefox/addon/keefox/versions should be fine.

Installing

Most users will be able to simply install the KeeFox addon from the official Firefox addons website and then follow the couple of instructions that KeeFox presents after restarting Firefox.

On Linux, some manual steps are required. See Installing on Linux for the procedure.

If you are unable to troubleshoot installation problems from the tips at the bottom of the getting started tutorial, you may want to read about how to perform a manual installation (see below).

Creating a database

When you first install KeeFox it needs to establish a secure connection to KeePass and during this setup process you are given the opportunity to set up a new password database. The options are deliberately minimised to help you to get a typical database up and running quickly.

If you need to create a new database at a later date you can use the standard KeePass database creation feature which has a few more options but it is understandable if you read the descriptions on the dialog carefully.

You can create a new database in KeePass by pressing the "new database" icon (top left white square with a star) or going to File / New. Further help should be available on the official KeePass help centre.

Importing passwords from other sources

Please see the page on the KeeFox website regarding data migration.

System requirements

Installing the KeeFox add-on through the official Firefox addons site is usually the easiest way to get KeeFox installed but if you need to refer to the system requirements...

Either Firefox 29.0 or higher

Or Thunderbird 29.0 or higher

Windows Vista or higher

• KeePass 2.18 or higher
• Microsoft .NET 2.0 or higher

Windows XP is no longer officially supported; it might still work but we strongly recommend upgrading since it is no longer possible to secure your password data on top of that insecure operating system.

Linux

• KeePass 2.19 or higher
• Mono 2.10 or higher

Mac OSX

• Unknown
• You should find it works if you get the latest version of OSX, Mono and KeePass but it's untested
• To get KeeFox working on a Mac you must install the KeeFox version from the development channel

You should use the latest version of KeePass if possible since this is what KeeFox is tested against. Unfortunately, from time to time new versions of KeePass are released which break KeeFox so there may be short periods where running the brand new version of KeePass is not possible.

Manual installation

KeeFox can be installed and configured manually if preferred. Exact steps will depend on your operating system, Firefox version, etc. but the following information should help you see what the end result needs to be in order for KeeFox to function correctly.

Firstly, the KeeFox Firefox add-on needs to be installed. This should be done in the same way as installing any other Firefox add-on.

You also need to install KeePass Password Safe 2. Again, follow standard installation procedures for an application and refer to http://keepass.info if you get stuck at this stage.

You need to then place the KeePassRPC.plgx file into a subfolder of the KeePass installation location called "plugins". It is important that you use the exact KeePassRPC.plgx file that is included with the version of KeeFox you have installed into Firefox. This file can be found in a couple of places:

• Inside the Firefox extension ".xpi" package.
  • A Firefox .xpi is just a zip folder so you can just rename the file ending to ".zip" and browse the contents of the zip file to find the plgx file inside the "deps" folder.
• Inside the extracted version of the extension in your Firefox profile directory (once the KeeFox add-on has been installed into Firefox).
  • First, find your profile directory - the easiest way is to load "about:support" (or click on "Help" / "Troubleshooting Information" in the Firefox/Thunderbird main menu) and click the button next to "Profile Folder" in the "Application Basics" section of that page.
  • Inside your profile directory navigate to "extensions", then "keefox@chris.tomlinson" and then "deps"

There is a possibility that KeePass plugins directory contains non-matching version of KeePassRPC.plgx with Firefox plugin version - which will result in such error in logs:

:ERROR: You must downgrade to version 67072 or upgrade KeePassRPC to match your version of KeeFox. Going to initiate the upgrade wizard now.

To avoid this version make sure both versions matches (for example firefox plugin 1.6.3 does not match with KeePassPlugin version 1.6.0.0)

The final step is to make sure that KeeFox knows where to find KeePass. There are text boxes in the "KeePass" tab of the KeeFox options dialog in Firefox where you can enter these details manually but if you have installed KeePass using the standard setup file you should find that KeeFox automatically detects the correct location when Firefox is restarted.